Foxit PDF Conversion SDK
FoxitPDFConversionSDKPython3.PDF2Md Class Reference
Inheritance diagram for FoxitPDFConversionSDKPython3.PDF2Md:
FoxitPDFConversionSDKPython3.Base

Static Public Member Functions

def ConvertToMarkdown (src_pdf_file_path, src_file_password, saved_md_path, saved_image_dir_name, setting_data)
 Convert a PDF format file to a Markdown file. More...
 

Detailed Description

This class can be used to convert PDF format files to Markdown files.

Member Function Documentation

◆ ConvertToMarkdown()

FoxitPDFConversionSDKPython3.PDF2Md.ConvertToMarkdown (   src_pdf_file_path,
  src_file_password,
  saved_md_path,
  saved_image_dir_name,
  setting_data 
)
static

Convert a PDF format file to a Markdown file.

Parameters
[in]src_pdf_file_pathPath of a PDF format file. This should not be an empty string.
[in]src_file_passwordPassword for the input file. Pass an empty string if no password.
[in]saved_md_pathPath of the saved Markdown file as conversion result. This should not be an empty string.
[in]saved_image_dir_nameName of the directory to save extracted images, placed next to the output Markdown file. Must be a plain folder name without path separators (e.g. "my_images"). Passing a path (containing '/', '\' or ':') will throw FoxitPDFConversionSDKPython3.e_ErrParam . If null or empty, images will be saved to a default directory named <md_basename>_images next to the output Markdown file.
[in]setting_dataA object for conversion settings. Default: default values.
Returns
true means success, while false means failure.